WebMoney決済クイック決済 API一覧

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranWebmoney 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字6桁利用金額利用可能決済金額をご確認ください。
Tax		半角数字6桁税送料利用可能決済金額をご確認ください。

URL

/payment/EntryTranWebmoney.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000&Tax=100

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranWebmoneyQuick クイック決済実行

WebMoneyセンターと通信を行い決済要求結果を返します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass		必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID		必須半角英数記号27桁オーダーID 【取引登録】で発行された値を設定します。
QuickID		必須半角英数32桁クイックID プリペイド番号を登録するクイックIDを指定します。初回購入時に、加盟店様にてお客様ごとにユニークなIDを割り当ててください。新規のクイックIDを指定した場合、支払手続き開始IFヘリダイレクトを行い、お客様をWebMoney決済画面に誘導してください。リダイレクト先の支払手続き開始IFから遷移したWebMoney決済画面でお客様がプリペイド番号を入力すると、プリペイド番号から決済金額が差し引かれ、プリペイド番号がクイックIDに登録されます。次回以降の購入時に、お客様に割り当てたクイックIDを指定して決済実行すると、クイックIDに登録されたプリペイド番号から決済金額が差し引かれ決済完了します。（WebMoney決済画面への誘導は不要です）
ItemName		必須全半角40バイト商品・サービス名 WebMoneyの決済画面に表示する商品名を設定します。
PaymentTermDay		半角数字2桁支払期限日数省略時は、ショップ情報に設定された支払期限日数で処理されます。
RedirectURL		必須半角英数記号256桁リダイレクトURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを指定します。クイックIDの初回登録や残高不足の場合はWebMoney決済画面への遷移が生じます。 WebMoney決済画面上でお客様が支払操作を完了した時や、キャンセルした時に、本項目で指定されたURLに結果を送信します。結果はリダイレクト経由で送信します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
ClientFieldFlag		半角数字1桁加盟店自由項目返却フラグ以下のいずれかを設定します。 0：返却しない(デフォルト) 1：返却する

URL

/payment/ExecTranWebmoneyQuick.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&QuickID=quickid00001&ItemName=テストギフト&PaymentTermDay=&RedirectURL=https://example.com/receive&ClientField1=&ClientField2=&ClientField3=&ClientFieldFlag=0

レスポンス

正常

ShopID		半角英数13桁ショップID
OrderID		半角英数記号27桁オーダーID
QuickID		半角英数32桁クイックID 【クイック決済実行】呼び出し時に指定した値を返却します。
Status		現状態該当取引の取引状態を返却します。 UNPROCESS：未決済 REQSUCCESS：要求成功 PAYSUCCESS：決済成功
TranDate		半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。(yyyyMMddHHmmss書式)
PayCancel		半角数字1桁固定キャンセル区分 "0"固定です。
ManagementNo		半角数字16桁管理番号決済完了した場合、支払手続きで使用されたWebMoneyの管理番号を返却します。
SettleCode		25桁決済コード決済完了した場合、WebMoneyセンターが返した決済コードを返却します。
CampaignUrl		半角英数記号256桁抽選結果表示URL 決済完了しWebMoneyの決済キャンペーンで当選した場合、当選確認用URLを返却します。 (返却値はURLエンコード値) ※当選しなかった場合は、本項目は空です。
CheckString		半角英数32桁 MD5ハッシュ出力内容のShopID～CampaignUrl+ショップパスワードをベースにしたハッシュ値を返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
NextStep		半角英字8桁次処理種別正常に決済要求が処理された場合は、次処理の種別を返却します。 FINISH：決済完了 CHARGE：支払手続き "FINISH"が返却された場合：指定されたクイックIDに登録されたプリペイド番号から決済金額が差し引かれ決済が完了しています。お客様に決済手続きの完了を案内してください。また、WebMoneyの決済キャンペーンの抽選に当選した場合、当選内容確認画面のURL(抽選結果表示URL)が返却されますので、お客様に当該URLを通知してください。 "CHARGE"が返却された場合：指定されたクイックIDに登録されたプリペイド番号が存在しないか、登録されたプリペイド番号の残高が決済金額に満たない状態です。クイック支払手続き開始IFのURLにお客様を誘導してください。
PaymentTerm		半角数字14桁固定支払期限日時支払手続きが必要な場合、お客様の支払手続き期限を返却します。 (yyyyMMddHHmmss書式)

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&QuickID=quickid00001&Status=PAYSUCCESS&TranDate=20221109090000&PayCancel=0&ManagementNo=20221109090007&SettleCode=SCI202211090000KS000000&CampaignUrl=&CheckString=749c03785f97d80a6eca895e81def981&ClientField1=&ClientField2=&ClientField3=&NextStep=FINISH&PaymentTerm=20221109235959

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

WebmoneyQuickStart 支払手続き開始IF呼び出し

クイック決済において、クイックIDの新規登録時、もしくは既存のクイックIDが残高不足の場合は、お客様をWebMoneyの決済画面へと遷移させる必要があります。
加盟店様のサイトから画面遷移させるために、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは、お客様をWebMoneyの決済画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。

URL

/payment/WebmoneyQuickStart.idPass

リクエストパラメータ

AccessID=a6a6b0061347e90cdef806b39bd28705

リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="WebmoneyStartCall" method="POST" action="{決済実行のレスポンスで返却した接続先URL}">
    <noscript>
      <h2>WebMoneyの決済画面へ遷移します。</h2>
      <input type="submit" value="続行">
     </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.WebmoneyStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

決済結果受信

WebMoneyセンターから、当サービスに支払操作結果が通知されます。
支払操作結果は、お客様が支払操作を完了した場合と支払操作をキャンセルした場合に通知されます。
※ブラウザを×ボタンで閉じた場合は、通知されません。
当サービスは、【クイック決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
※リダイレクトURLが指定されていない場合は、当サービスの購入完了画面またはキャンセル画面を表示します。

レスポンス

正常

ShopID		半角英数13桁ショップID
OrderID		半角英数記号27桁オーダーID
QuickID		半角英数32桁クイックID
Status		現状態該当取引の取引状態を返却します。 PAYSUCCESS：決済完了 PAYFAIL：決済失敗
TranDate		半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。（yyyyMMddHHmmss書式）
PayCancel		半角数字1桁キャンセル区分以下のいずれかを返却します。 1：支払操作がキャンセルされた場合 0：その他
ManagementNo		半角英数16桁管理番号決済完了した場合、支払手続きで使用されたWebMoneyの管理番号を返却します。
SettleCode		半角英数25桁決済コード決済完了した場合、WebMoneyセンターが返した決済コードを返却します。
CampaignUrl		半角英数記号256桁抽選結果表示URL 決済完了しWebMoneyの決済キャンペーンで当選した場合、当選確認用URLを返却します。 (返却値はURLエンコード値) ※当選しなかった場合は、本項目は空です。
CheckString		半角英数32桁 MD5ハッシュ出力内容のShopID～CampaignUrl+ショップパスワードをベースにしたハッシュ値を返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
NextStep		半角英字8桁次処理種別 "FINISH"固定
PaymentTerm		半角数字14桁固定支払期限日時空文字固定

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

DeleteWebmoneyQuickId クイックID削除

指定されたクイックIDを無効化します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
QuickID		必須半角英数32桁クイックID 削除するクイックIDを指定します。

URL

/payment/DeleteWebmoneyQuickId.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&QuickID=quickid00001

レスポンス

正常

QuickID		半角英数32桁クイックID 入力パラメータの値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

QuickID=quickid00001

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

HistoryWebmoneyQuickId クイックID利用明細URL取得

指定されたクイックIDの利用明細画面のURLを取得します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
QuickID		必須半角英数32桁クイックID 表示対象のクイックIDを指定します。
ReturnUrl		必須半角英数記号256桁戻り先URL 利用明細画面の「戻る」ボタンの遷移先のURLを設定します。

URL

/payment/HistoryWebmoneyQuickId.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&QuickID=quickid00001&ReturnUrl=https://example.com/receive

レスポンス

正常

QuickID		半角英数32桁クイックID 入力パラメータの値を返却します。
HistoryUrl		半角英数記号256桁利用明細画面URL 利用明細画面のURLを返却します。
ExpireDate		半角数字14桁固定有効期限利用明細画面URLの有効期限を返却します。(yyyyMMddhhmmss形式)

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

QuickID=quickid00001&HistoryUrl=https%3A%2F%2Fwww.webmoney.ne.jp%2FquickSettle%2Fwmc%2FcheckInfo%3Finfo%3Dtest&ExpireDate=20221109595959

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RefundWebmoney 返品

決済が完了した取引に対して、決済内容の取消を行います。
※加盟店様の契約コードによっては、返品できません。（返品可否については事前にお問い合わせください）

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass		必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。

URL

/payment/RefundWebmoney.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		半角英数記号27桁オーダーID 入力パラメータの値を返却します。
Status		現状態処理成功時は以下のステータスが返却されます。・RETURN 処理失敗時は処理前のステータスが返却されます。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=RETURN

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数27桁オーダーID
PayType		必須半角数字2桁決済方法 7：WebMoney

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=7

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 PAYSTART：決済開始 PAYSUCCESS：決済完了 PAYFAIL：決済失敗 EXPIRED：期限切れ RETURN：返品
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字10桁利用金額
Tax		半角数字10桁税送料
Currency		半角英字3桁通貨コード決済に利用された通貨を返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 7：WebMoney
PaymentTerm		半角数字14桁支払期限日時 yyyyMMddHHmmss書式
WebMoneyManagementNo		16桁管理番号
WebMoneySettleCode		25桁決済コード WebMoneyセンターが返却した決済コード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=PAYSUCCESS&ProcessDate=20210308125035&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&SiteID=&Currency=JPY&ClientField1=&ClientField2=&ClientField3=&PayType=7&PaymentTerm=20210308125035&WebMoneyManagementNo=20221109090007&WebMoneySettleCode=SCI202211090000KS000000&

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

WebMoney決済